QueryTransactions

The QueryTransactions web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to retrieve transaction summary information for a Subscriber's CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices..

The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Account Number in order to retrieve the associated list of transactions, as held in the Transactions panel of the CMP Account Summary screen. This list of transactions includes Invoices, Payments, and Credits.

A transactions filter option is available to enable the user to select either Posted - Unmatched (Open) or Posted - All. One of these filter options must be submitted as part of the web service request.

The response returns a list of transactions, including the appropriate dates and amounts of the transaction.

A maximum is applied to the number of transactions that can be returned in a single web service call. If this limit is exceeded, the maximum number of records is still returned but the user is notified that the limit has been reached.

To avoid performance problems, the number of returned transactions should not exceed twenty .

Submitting invalid data in the request will result in an error message.

QueryTransactions Request

The QueryTransactions tag instructs the Financials Service to query transactions on an Account. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
AccountNumber	Integer8	The unique number automatically generated when the Account record is created.	Mandatory
TransactionsData	String	One of: POSTED_UNMATCHED POSTED_ALL	Mandatory

QueryTransactions Response

QueryTransactions response is the response to the QueryTransactionDetails Request. This response contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
TransactionData	Container	Contains one or more Transaction. See TransactionData Response Container for details.	Mandatory
QueryLimitExceeded	Boolean	Set to True if the configured maximum number of records returned was exceeded.	Mandatory

Transactions are returned ordered by most recent date first (ascending date). However if there are multiple transactions on the same date, these transactions are in descending time order. For example, if there were two payments on the same day, the first transaction will be the earlier of the two, with the second transaction being the later one.

TransactionsData Response Container

The TransactionsData response container has the following elements:

Element Name	Content Type	Description	Required?
Transaction	Container	See Transaction Response Container for details.	Optional

Transaction

The Transaction response container has the following elements:

Element Name	Content Type	Description	Required?
ReferenceNumber	Integer8	This displays either an Invoice Number, Credit Note Number or Payment Reference Number.	Mandatory
Description	String30	This indicates if the Transaction relates to an Invoice, Credit, Debit, Payment Received, etc.	Mandatory
TaxDate	Date	This displays the date on which the Transaction was applied to the account. YYYY-MM-DDZ	Mandatory
Remark	String30	This provides a more detailed indication of the Transaction Type (i.e. multi- subscription invoice).	Mandatory
GrossAmount	Currency (Decimal)	This displays the total value of the transaction. Min Inclusive: -999999999.99 Max Inclusive: 999999999.99	Mandatory
OpenAmount	Currency (Decimal)	This displays the value of any outstanding transactions. This field relates to the balance of the gross amount of the transaction. Min Inclusive: -999999999.99 Max Inclusive: 999999999.99	Mandatory
PaymentDue/ReceivedDate	Date	This details the date the monies should be paid by or the date the monies were received or the date the credit/debit was applied. YYYY-MM-DDZ	Mandatory
TransactionType	String - Enumeration	Choice of: INVOICE PAYMENT	Mandatory

Sample QueryTransactions Response